Skip to main content

Cara Membuat Dokumentasi dengan Format Markdown di Docusaurus

Docusaurus menggunakan format Markdown untuk membuat dokumentasi dengan mudah. Di bawah ini adalah langkah-langkah untuk membuat dokumen di Docusaurus menggunakan format markdown.

Langkah 1: Masuk ke Folder docs​

Setelah menginstal Docusaurus, semua file dokumentasi disimpan dalam folder docs. Untuk mulai membuat dokumentasi, buka terminal dan masuk ke folder docs:

cd docs

Setelah itu, gunakan perintah ls untuk melihat daftar folder dan file yang ada di dalamnya:

ls

Di dalam folder docs, kamu akan menemukan beberapa file dan folder. Salah satu file yang ada adalah intro.md, yang digunakan sebagai halaman pertama (index) ketika seseorang mengunjungi bagian docs dari blog kamu.

Langkah 2: Membuat File Markdown Baru​

Untuk membuat tampilan atau dokumen pertama kamu, buat file markdown baru (misalnya, intro.md). Berikut adalah contoh konten untuk file intro.md yang dapat kamu gunakan sebagai halaman selamat datang atau sesuai keinginan kamu.

Contoh Konten File intro.md:​

---
sidebar_position: 1
id: welcome
title: Hallo semuanya
description: ini adalah website blog dan documentation ku
---

### hai semuanya
- ini adalah contoh intronya
- untuk `intro.md`
  • sidebar_position: Menentukan posisi file ini di sidebar.
  • id: Identitas unik untuk file ini.
  • title: Judul halaman ini.
  • description: Deskripsi halaman ini.

Langkah 3: Menyimpan dan Menampilkan di Browser​

Setelah kamu selesai membuat dan menyimpan file intro.md, kamu bisa mencoba untuk melihat hasilnya di browser. Jika Docusaurus sudah berjalan di mode pengembangan, cukup buka browser dan akses situs kamu.

Jika belum aktif, jalankan server lokal dengan perintah:

npm start -- --port 80

Server Docusaurus akan berjalan pada port 80, dan kamu bisa melihat dokumentasi kamu langsung di browser.

Hasilnya​

Setelah langkah-langkah di atas, file intro.md akan ditampilkan sebagai halaman pertama di bagian docs. Kamu akan melihat tampilan seperti ini:

Hallo semuanya​

  • ini adalah contoh intronya
  • untuk intro.md

Gambar Hasilnya:
Contoh Dengan langkah-langkah ini, kamu bisa mulai membuat dokumentasi menggunakan Docusaurus dengan format markdown yang mudah dipahami dan diatur. Semoga membantu! 😊